<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>include/shark/Models/Clustering/AbstractClustering.h Source File</title>
<script type="text/javaScript" src="search/search.js"></script>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3.0.1/es5/tex-mml-chtml.js"></script>
<script src="../../mlstyle.js"></script>
<link href="../css/besser.css" rel="stylesheet" type="text/css"/>
</head>
<!-- pretty cool: each body gets an id tag which is the basename of the web page  -->
<!--              and allows for page-specific CSS. this is client-side scripted, -->
<!--              so the id will not yet show up in the served source code -->
<script type="text/javascript">
    jQuery(document).ready(function () {
        var url = jQuery(location).attr('href');
        var pname = url.substr(url.lastIndexOf("/")+1, url.lastIndexOf(".")-url.lastIndexOf("/")-1);
        jQuery('#this_url').html('<strong>' + pname + '</strong>');
        jQuery('body').attr('id', pname);
    });
</script>
<body>
    <div id="shark_old">
        <div id="wrap">
            <div id="header">
                <div id="site-name"><a href="../../sphinx_pages/build/html/index.html">Shark machine learning library</a></div>
                <ul id="nav">
                    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/installation.html">Installation</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/tutorials/tutorials.html">Tutorials</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/benchmark.html">Benchmarks</a>
                    </li>
                    <li class="active">
                        <a href="classes.html">Documentation</a>
                        <ul>
                            <li class="first"></li>
                            <li><a href="../../sphinx_pages/build/html/rest_sources/quickref/quickref.html">Quick references</a></li>
                            <li><a href="classes.html">Class list</a></li>
                            <li class="last"><a href="group__shark__globals.html">Global functions</a></li>
                        </ul>
                    </li>
                </ul>
            </div>
        </div>
    </div>
<div id="doxywrapper">
<!--
    <div id="global_doxytitle">Doxygen<br>Documentation:</div>
-->
    <div id="navrow_wrapper">
<!-- Generated by Doxygen 1.9.8 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9d0c4981f10d03078bcfd5c74fe41ce8.html">shark</a></li><li class="navelem"><a class="el" href="dir_d88670438e31f34fbe7ccda1c525ad9e.html">Models</a></li><li class="navelem"><a class="el" href="dir_622e836ee13b96c1f05b3b254dfc470c.html">Clustering</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">AbstractClustering.h</div></div>
</div><!--header-->
<div class="contents">
<a href="_abstract_clustering_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">//===========================================================================</span><span class="comment"></span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">/*!</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> * </span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * \brief       Super class for clustering definitions.</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * \file</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * </span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> * \author      T. Glasmachers</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> * \date        2011</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> *</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> *</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * \par Copyright 1995-2017 Shark Development Team</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * </span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * &lt;BR&gt;&lt;HR&gt;</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * This file is part of Shark.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"> * &lt;https://shark-ml.github.io/Shark/&gt;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment"> * </span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"> * Shark is free software: you can redistribute it and/or modify</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="comment"> * it under the terms of the GNU Lesser General Public License as published </span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="comment"> * by the Free Software Foundation, either version 3 of the License, or</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="comment"> * (at your option) any later version.</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="comment"> * </span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="comment"> * Shark is distributed in the hope that it will be useful,</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="comment"> * GNU Lesser General Public License for more details.</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment"> * </span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment"> * You should have received a copy of the GNU Lesser General Public License</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment"> * along with Shark.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"> *</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"> */</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment">//===========================================================================</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="preprocessor">#ifndef SHARK_MODELS_CLUSTERING_ABSTRACTCLUSTERING_H</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="preprocessor">#define SHARK_MODELS_CLUSTERING_ABSTRACTCLUSTERING_H</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="preprocessor">#include &lt;<a class="code" href="_batch_interface_8h.html">shark/Data/BatchInterface.h</a>&gt;</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="preprocessor">#include &lt;<a class="code" href="_flags_8h.html">shark/Core/Flags.h</a>&gt;</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="preprocessor">#include &lt;<a class="code" href="_i_nameable_8h.html">shark/Core/INameable.h</a>&gt;</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="preprocessor">#include &lt;<a class="code" href="_i_parameterizable_8h.html">shark/Core/IParameterizable.h</a>&gt;</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="preprocessor">#include &lt;<a class="code" href="_i_serializable_8h.html">shark/Core/ISerializable.h</a>&gt;</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="preprocessor">#include &lt;<a class="code" href="_shape_8h.html">shark/Core/Shape.h</a>&gt;</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceshark.html" title="AbstractMultiObjectiveOptimizer.">shark</a> {</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>    <span class="comment"></span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment">///\defgroup clustering Clustering Algorithms</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment">/// </span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment">/// A variety of models and algorithms for clustering</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment">/// \ingroup models</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"></span><span class="comment"></span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment">///</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment">/// \brief Base class for clustering.</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment">///</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment">/// \par</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment">/// Clustering algorithms vary widely in the data structures</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment">/// on which they operate. For example, simple centroid-based</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment">/// approaches such as k-means are mutually incompatible with</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment">/// tree-based hierarchical clustering. This interface class</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment">/// is the attempt to cast different cluster descriptions into</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment">/// a minimal common interface that is useful for prediction.</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment">///</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment">/// \par</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment">/// There are at least two common types of predictions made</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment">/// with clusterings. The first one is the assignment of the</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment">/// best matching cluster to a patters, such as in vector</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment">/// quantization or unsupervised clustering. This is often</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment">/// referred to as &quot;hard clustering&quot;. The second one is the</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment">/// computation of a membership function (&quot;soft clustering&quot;).</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment">/// The membership of a pattern to a cluster is non-negative,</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment">/// and the total membership should add to one.</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment">///</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment">/// \par</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment">/// This interface makes minimal assumptions to allow for</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment">/// these types of predictions. It assumes that clusters can</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment">/// be enumbered (identified by an index), and that at least</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment">/// a membership test can be made (hard clustering). It is</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment">/// optional to provide a membership function. Only one of</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment">/// the two interfaces for best matching cluster or membership</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment">/// function need to be implemented, since the best matching</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment">/// cluster can be deduced from the membership function.</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment">/// However, often the best matching cluster can be computed</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment">/// more efficiently than the membership function. In these</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment">/// cases both interface functions should be implemented.</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment">///</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment">/// \par</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment">/// The purpose of this interface is to act as a common</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment">/// super class to different data structures describing the</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment">/// outcome of a clustering operation. The interface allows</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment">/// all of these data structures to be used in the two</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment">/// clustering model classes: HardClusteringModel and</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment">/// SoftClusteringModel.</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment">///</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment">/// \ingroup clustering</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment"></span><span class="keyword">template</span> &lt;<span class="keyword">class</span> InputT&gt;</div>
<div class="foldopen" id="foldopen00097" data-start="{" data-end="};">
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="classshark_1_1_abstract_clustering.html">   97</a></span><span class="keyword">class </span><a class="code hl_class" href="classshark_1_1_abstract_clustering.html" title="Base class for clustering.">AbstractClustering</a> : <span class="keyword">public</span> <a class="code hl_class" href="classshark_1_1_i_nameable.html" title="This class is an interface for all objects which can have a name.">INameable</a>, <span class="keyword">public</span> <a class="code hl_class" href="classshark_1_1_i_parameterizable.html" title="Top level interface for everything that holds parameters.">IParameterizable</a>&lt;&gt;, <span class="keyword">public</span> <a class="code hl_class" href="classshark_1_1_i_serializable.html" title="Abstracts serializing functionality.">ISerializable</a></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span>{</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"><a class="line" href="classshark_1_1_abstract_clustering.html#a519bea30fafabdaff33a85a1c27b8a85">  100</a></span>    <span class="keyword">typedef</span> InputT <a class="code hl_typedef" href="classshark_1_1_abstract_clustering.html#a519bea30fafabdaff33a85a1c27b8a85">InputType</a>;</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"><a class="line" href="classshark_1_1_abstract_clustering.html#a42901ac7a67744a4dd7c785bb9407d7c">  101</a></span>    <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code hl_typedef" href="classshark_1_1_abstract_clustering.html#a42901ac7a67744a4dd7c785bb9407d7c">OutputType</a>;</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"><a class="line" href="classshark_1_1_abstract_clustering.html#a6865af40b0cab718706e9360b29f2a2c">  102</a></span>    <span class="keyword">typedef</span> <span class="keyword">typename</span> <a class="code hl_struct" href="structshark_1_1_batch.html" title="class which helps using different batch types">Batch&lt;InputType&gt;::type</a> <a class="code hl_typedef" href="classshark_1_1_abstract_clustering.html#a6865af40b0cab718706e9360b29f2a2c">BatchInputType</a>;</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"><a class="line" href="classshark_1_1_abstract_clustering.html#a0857a0698bf699be93ccf595406bdf96">  103</a></span>    <span class="keyword">typedef</span> <a class="code hl_struct" href="structshark_1_1_batch.html" title="class which helps using different batch types">Batch&lt;OutputType&gt;::type</a> <a class="code hl_typedef" href="classshark_1_1_abstract_clustering.html#a0857a0698bf699be93ccf595406bdf96">BatchOutputType</a>;</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span> </div>
<div class="foldopen" id="foldopen00105" data-start="{" data-end="};">
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"><a class="line" href="classshark_1_1_abstract_clustering.html#a2e5bf11e84922991bf66f4198a96e4e7">  105</a></span>    <span class="keyword">enum</span> <a class="code hl_enumeration" href="classshark_1_1_abstract_clustering.html#a2e5bf11e84922991bf66f4198a96e4e7">Feature</a> {</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"><a class="line" href="classshark_1_1_abstract_clustering.html#a2e5bf11e84922991bf66f4198a96e4e7a183a78cbfd5ccf4d69f2b0e733af6ad3">  106</a></span>        <a class="code hl_enumvalue" href="classshark_1_1_abstract_clustering.html#a2e5bf11e84922991bf66f4198a96e4e7a183a78cbfd5ccf4d69f2b0e733af6ad3">HAS_SOFT_MEMBERSHIP</a> = 1,</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span>    };</div>
</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="classshark_1_1_abstract_clustering.html#ad7affb5327cd577e528b50405564ca71">  108</a></span>    <a class="code hl_define" href="_flags_8h.html#a3c3e2d17f85cf4a10ea888742a4b95a3">SHARK_FEATURE_INTERFACE</a>;</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"></span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment">    /// Tests whether the clustering can compute a (soft)</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment">    /// member ship function, describing the membership</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment">    /// of a sample to the different clusters.</span></div>
<div class="foldopen" id="foldopen00113" data-start="{" data-end="}">
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"><a class="line" href="classshark_1_1_abstract_clustering.html#a48971e367865d932891873c21cb4e849">  113</a></span><span class="comment"></span>    <span class="keywordtype">bool</span> <a class="code hl_function" href="classshark_1_1_abstract_clustering.html#a48971e367865d932891873c21cb4e849">hasSoftMembershipFunction</a>()<span class="keyword">const</span>{</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span>        <span class="keywordflow">return</span> <a class="code hl_variable" href="classshark_1_1_abstract_clustering.html#a75910ba675486528e27893a95608510d">m_features</a> &amp; <a class="code hl_enumvalue" href="classshark_1_1_abstract_clustering.html#a2e5bf11e84922991bf66f4198a96e4e7a183a78cbfd5ccf4d69f2b0e733af6ad3">HAS_SOFT_MEMBERSHIP</a>;</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span>    }</div>
</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment"></span> </div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment">    /// return the number of clusters</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"><a class="line" href="classshark_1_1_abstract_clustering.html#a2c913637b84340135b606912228f5851">  118</a></span><span class="comment"></span>    <span class="keyword">virtual</span> std::size_t <a class="code hl_function" href="classshark_1_1_abstract_clustering.html#a2c913637b84340135b606912228f5851" title="return the number of clusters">numberOfClusters</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span>    </div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"><a class="line" href="classshark_1_1_abstract_clustering.html#a877c93a51f9416ce0f7dec4645086fc8">  120</a></span>    <span class="keyword">virtual</span> <a class="code hl_class" href="classshark_1_1_shape.html" title="Represents the Shape of an input or output.">Shape</a> <a class="code hl_function" href="classshark_1_1_abstract_clustering.html#a877c93a51f9416ce0f7dec4645086fc8">inputShape</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment"></span> </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment">    /// \brief Compute best matching cluster.</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment">    ///</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment">    /// \par</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment">    /// This function should be overriden by sub-classes to</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment">    /// compute the cluster best matching the input pattern.</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment">    /// The (typically slow) default implementation is to</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment">    /// create a batch of size 1 and return the result of the batch call to hardMembership</span></div>
<div class="foldopen" id="foldopen00129" data-start="{" data-end="}">
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"><a class="line" href="classshark_1_1_abstract_clustering.html#a1b9a35a33f14aab84aac1cbf767bb813">  129</a></span><span class="comment"></span>    <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code hl_function" href="classshark_1_1_abstract_clustering.html#a1b9a35a33f14aab84aac1cbf767bb813" title="Compute best matching cluster.">hardMembership</a>(<a class="code hl_typedef" href="classshark_1_1_abstract_clustering.html#a519bea30fafabdaff33a85a1c27b8a85">InputType</a> <span class="keyword">const</span>&amp; pattern)<span class="keyword"> const</span>{</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span>        <span class="keyword">typename</span> <a class="code hl_struct" href="structshark_1_1_batch.html" title="class which helps using different batch types">Batch&lt;InputType&gt;::type</a> b = <a class="code hl_struct" href="structshark_1_1_batch.html" title="class which helps using different batch types">Batch&lt;InputType&gt;::createBatch</a>(pattern);</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span>        <a class="code hl_function" href="namespaceshark.html#a1531880b9b4076854b0b26441d353242">getBatchElement</a>(b,0) = pattern;</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span>        <span class="keywordflow">return</span> <a class="code hl_function" href="classshark_1_1_abstract_clustering.html#a1b9a35a33f14aab84aac1cbf767bb813" title="Compute best matching cluster.">hardMembership</a>(b)(0);</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span>    }</div>
</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span>    <span class="comment"></span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment">    /// \brief Compute best matching cluster for a batch of inputs.</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment">    ///</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment">    /// \par</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment">    /// This function should be overriden by sub-classes to</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment">    /// compute the cluster best matching the input pattern.</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment">    /// The (typically slow) default implementation is to</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment">    /// return the arg max of the soft membership function for every pattern.</span></div>
<div class="foldopen" id="foldopen00142" data-start="{" data-end="}">
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"><a class="line" href="classshark_1_1_abstract_clustering.html#af11841eae50fa5d031a7a6706e0fa9d9">  142</a></span><span class="comment"></span>    <span class="keyword">virtual</span> <a class="code hl_typedef" href="classshark_1_1_abstract_clustering.html#a0857a0698bf699be93ccf595406bdf96">BatchOutputType</a> <a class="code hl_function" href="classshark_1_1_abstract_clustering.html#af11841eae50fa5d031a7a6706e0fa9d9" title="Compute best matching cluster for a batch of inputs.">hardMembership</a>(<a class="code hl_typedef" href="classshark_1_1_abstract_clustering.html#a6865af40b0cab718706e9360b29f2a2c">BatchInputType</a> <span class="keyword">const</span>&amp; patterns)<span class="keyword"> const</span>{</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span>        std::size_t numPatterns = <a class="code hl_function" href="namespaceshark.html#af2ab10364feb8a631e0866dcf2f1a4ad">batchSize</a>(patterns);</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span>        RealMatrix f = <a class="code hl_function" href="classshark_1_1_abstract_clustering.html#abccfaab4d2d5c26ff5a16d7b085365d1" title="Compute cluster membership function.">softMembership</a>(patterns);</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span>        <a class="code hl_define" href="_exception_8h.html#a73abb5049a0168d72a48e72dda41708b">SHARK_ASSERT</a>(f.size2() &gt; 0);</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span>        <a class="code hl_define" href="_exception_8h.html#a73abb5049a0168d72a48e72dda41708b">SHARK_ASSERT</a>(f.size1() == numPatterns);</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span>        <a class="code hl_typedef" href="classshark_1_1_abstract_clustering.html#a0857a0698bf699be93ccf595406bdf96">BatchOutputType</a> outputs(numPatterns);</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span>        <span class="keywordflow">for</span>(std::size_t i = 0; i != numPatterns;++i){</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span>            <span class="keyword">auto</span> membership = row(f,i);</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span>            outputs(i) = (<span class="keywordtype">unsigned</span> int)(std::max_element(membership.begin(),membership.end())-membership.begin());</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span>        }</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span>        <span class="keywordflow">return</span> outputs;</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span>    }</div>
</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment"></span> </div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment">    /// \brief Compute cluster membership function.</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment">    ///</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment">    /// \par</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment">    /// This function should be overriden by sub-classes to</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment">    /// compute the membership of a pattern to the clusters.</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment">    /// The default implementation creates a batch of size 1 </span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment">    /// and calls the batched version. If this is not overriden, an xception is thrown.</span></div>
<div class="foldopen" id="foldopen00162" data-start="{" data-end="}">
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"><a class="line" href="classshark_1_1_abstract_clustering.html#abccfaab4d2d5c26ff5a16d7b085365d1">  162</a></span><span class="comment"></span>    <span class="keyword">virtual</span> RealVector <a class="code hl_function" href="classshark_1_1_abstract_clustering.html#abccfaab4d2d5c26ff5a16d7b085365d1" title="Compute cluster membership function.">softMembership</a>(<a class="code hl_typedef" href="classshark_1_1_abstract_clustering.html#a519bea30fafabdaff33a85a1c27b8a85">InputType</a> <span class="keyword">const</span>&amp; pattern)<span class="keyword"> const</span>{</div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span>        <span class="keyword">auto</span> output = <a class="code hl_function" href="classshark_1_1_abstract_clustering.html#abccfaab4d2d5c26ff5a16d7b085365d1" title="Compute cluster membership function.">softMembership</a>(<a class="code hl_struct" href="structshark_1_1_batch.html" title="class which helps using different batch types">Batch&lt;InputType&gt;::createBatch</a>(pattern));</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span>        <span class="keywordflow">return</span> row(output,0);</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span>    }</div>
</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span>    <span class="comment"></span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment">    /// \brief Compute cluster membership function.</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="comment">    ///</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment">    /// \par</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="comment">    /// This function should be overriden by sub-classes to</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="comment">    /// compute the membership of a pattern to the clusters.</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment">    /// This default implementation throws an exception.</span></div>
<div class="foldopen" id="foldopen00173" data-start="{" data-end="}">
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"><a class="line" href="classshark_1_1_abstract_clustering.html#ad6babdbb7b5979c5651698982fea7ca0">  173</a></span><span class="comment"></span>    <span class="keyword">virtual</span> RealMatrix <a class="code hl_function" href="classshark_1_1_abstract_clustering.html#ad6babdbb7b5979c5651698982fea7ca0" title="Compute cluster membership function.">softMembership</a>(<a class="code hl_typedef" href="classshark_1_1_abstract_clustering.html#a6865af40b0cab718706e9360b29f2a2c">BatchInputType</a> <span class="keyword">const</span>&amp; patterns)<span class="keyword"> const</span>{</div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span>        <a class="code hl_define" href="_flags_8h.html#a6e41326253dee198183b5cbde3570c6c">SHARK_FEATURE_EXCEPTION</a>(<a class="code hl_enumvalue" href="classshark_1_1_abstract_clustering.html#a2e5bf11e84922991bf66f4198a96e4e7a183a78cbfd5ccf4d69f2b0e733af6ad3">HAS_SOFT_MEMBERSHIP</a>);</div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span>    }</div>
</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="comment"></span> </div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span><span class="comment">    /// empty default implementation of ISerializable::read</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"><a class="line" href="classshark_1_1_abstract_clustering.html#a716046b5e610f0a26e3462d8dda27f45">  178</a></span><span class="comment"></span>    <span class="keywordtype">void</span> <a class="code hl_function" href="classshark_1_1_abstract_clustering.html#a716046b5e610f0a26e3462d8dda27f45" title="empty default implementation of ISerializable::read">read</a>(<a class="code hl_typedef" href="namespaceshark.html#ada68729491840669e47c8ad42282424f" title="Type of an archive to read from.">InArchive</a>&amp; archive) {}</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="comment"></span> </div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment">    /// empty default implementation of ISerializable::write</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"><a class="line" href="classshark_1_1_abstract_clustering.html#a1256454c153c93d532738311bf7600a0">  181</a></span><span class="comment"></span>    <span class="keywordtype">void</span> <a class="code hl_function" href="classshark_1_1_abstract_clustering.html#a1256454c153c93d532738311bf7600a0" title="empty default implementation of ISerializable::write">write</a>(<a class="code hl_typedef" href="namespaceshark.html#af4f8eb8e9618f5236b71bbcb12b8a524" title="Type of an archive to write to.">OutArchive</a>&amp; archive)<span class="keyword"> const </span>{}</div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span>};</div>
</div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span> </div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span> </div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span>}</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div>
</body>
</html>
